<html>
<head><meta charset="utf-8"><title>documentation coverage sketch · t-compiler · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/index.html">t-compiler</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html">documentation coverage sketch</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="157204553"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157204553" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157204553">(Jan 30 2019 at 17:28)</a>:</h4>
<p>currently sketching out a <code>--show-coverage</code> option for rustdoc that counts the public items in the given crate and prints out some stats</p>
<p><a href="/user_uploads/4715/pOH2-yRs6DwghrCiELMAdrId/pasted_image.png" target="_blank" title="pasted_image.png">pasted image</a></p>
<div class="message_inline_image"><a href="/user_uploads/4715/pOH2-yRs6DwghrCiELMAdrId/pasted_image.png" target="_blank" title="pasted image"><img src="/user_uploads/4715/pOH2-yRs6DwghrCiELMAdrId/pasted_image.png"></a></div>



<a name="157204624"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157204624" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157204624">(Jan 30 2019 at 17:29)</a>:</h4>
<p>right now i'm excluding anything that wasn't originally defined in the current crate - i.e. re-exports aren't counted because they count toward their original crate</p>



<a name="157204707"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157204707" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157204707">(Jan 30 2019 at 17:30)</a>:</h4>
<p>i'm considering counting trait impls separately, because often they don't <em>need</em> to be documented individually - the trait's own documentation can cover for them</p>



<a name="157204727"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157204727" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157204727">(Jan 30 2019 at 17:30)</a>:</h4>
<p>just thought i'd show it off here since the discussions about "doc coverage" in here were what inspired it</p>



<a name="157205242"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157205242" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> nagisa <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157205242">(Jan 30 2019 at 17:37)</a>:</h4>
<p><code>mod</code>s are also items, do these get counted as well?</p>



<a name="157205375"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157205375" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157205375">(Jan 30 2019 at 17:39)</a>:</h4>
<p>yes</p>



<a name="157205404"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157205404" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157205404">(Jan 30 2019 at 17:40)</a>:</h4>
<p>one of the missing items in this sample were the crate-root docs</p>



<a name="157209607"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157209607" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Wesley Wiser <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157209607">(Jan 30 2019 at 18:34)</a>:</h4>
<p><span class="user-mention" data-user-id="133692">@QuietMisdreavus</span> That's looks cool! <span aria-label="thumbs up" class="emoji emoji-1f44d" role="img" title="thumbs up">:thumbs_up:</span></p>



<a name="157214731"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157214731" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157214731">(Jan 30 2019 at 19:33)</a>:</h4>
<p>hmm, is there a way to tell whether an item was created by a derive macro? a lot of the non-documented items in my twitter library came from <code>#[derive(Serialize)]</code></p>



<a name="157214765"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157214765" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157214765">(Jan 30 2019 at 19:33)</a>:</h4>
<p>i know the built-in derives get <code>#[automatically_derived]</code> on them (and i'm already skipping those) but proc-macros don't have the same luxury</p>



<a name="157215564"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/documentation%20coverage%20sketch/near/157215564" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> QuietMisdreavus <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/documentation.20coverage.20sketch.html#157215564">(Jan 30 2019 at 19:43)</a>:</h4>
<p>current status, when running it on my twitter library</p>
<p><a href="/user_uploads/4715/-eSkLXdD-zC5f2UzH3h2YSAV/pasted_image.png" target="_blank" title="pasted_image.png">pasted image</a></p>
<div class="message_inline_image"><a href="/user_uploads/4715/-eSkLXdD-zC5f2UzH3h2YSAV/pasted_image.png" target="_blank" title="pasted image"><img src="/user_uploads/4715/-eSkLXdD-zC5f2UzH3h2YSAV/pasted_image.png"></a></div>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>